home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / gfx / conv / CreateIndex.lha / CreateIndex.doc < prev    next >
Text File  |  1999-01-21  |  5KB  |  125 lines

  1.                              CreateIndex
  2.                              ===========
  3.    An arexx script to create HTML picture index using ImageStudio
  4.                             Release v3.1
  5. Contents
  6.  
  7.     What does it do?
  8.     How do you use it?
  9.     To do
  10.     History
  11.     Who wrote this?
  12.     
  13.     
  14. What does it do?
  15.  
  16. Anyone with more than a handful of pictures with know that even with the
  17. most verbose filenames it can still be hard to track down the particular image
  18. which you seek. So people have written various proggys to catalogue your
  19. pics. The simplest of these being those that create thumbnails (small
  20. versions) of your pics and generate a HTML file to allow them to be
  21. viewed in favouite browser. You've guessed it this is what CreateIndex does!
  22.  
  23.     Requirements
  24.     
  25.         An Amiga!
  26.         ImageStudio, available free with CU Amiga May 1997
  27.         Arexx, preferable running
  28.         Graphical HMTL viewer, a browser or HTML datatype, only neccessary
  29.         if you wish to view the results!?
  30.     
  31.     Features
  32.     
  33.         Small, its an Arexx script
  34.         Fast, uses ImageStudio rather than datatypes
  35.         Update index, doesn't regenerate thumbnails
  36.         Can generate image dimensions for progressive loading,
  37.             alternative version
  38.         Generates text links for unrecognised files, this is mainly because
  39.         ImageStudio can't load progressive jpegs (its only failing), but you
  40.         could actually create a table of document links!
  41.         Generates multiple pages with previous and next links
  42.         Writes the sizes for all the thumbnails for fast loading of tables
  43.         Loads of comments in the script, simply unheard of!
  44.         Some extra scripts that may be of interest
  45.  
  46.     
  47. How do you use it?
  48.  
  49. Installation
  50.  
  51. Copy the files from the Rexx directory to your ImageStufdio/Rexx
  52. directory. Stick this file where you like it. That's all.
  53.  
  54.     CreateIndex.isrx - original script
  55.  
  56. Extra Scripts
  57.  
  58.  
  59.     Convert2PNG.isrx - does exactly what it says
  60.     Convert2PNG16BW.isrx  - generates 16 colour greyscale PNG,
  61.     useful for black and white artwork
  62.     BatchProcess.isrx - update of original example script, now
  63.     supports all formats that ImageStudio has
  64.     BatchProcessNotify.isrx - update of original example script,
  65.     now supports all formats that ImageStudio has
  66.  
  67.  
  68. Usage
  69.  
  70. Initially : Open the scripts window in ImageStudio and double click
  71. on CreateIndex. Shift select all files you want to be in index or just hit
  72. 'All'. Wait with baited breath. A file called index.html will be generated in the
  73. directory as well as the thumbnails. If you have selected more than row*columns images (default 10*5=50)
  74. additional files called index2.html etc. will be created.
  75. Updating : If you have added more files to a directory simply repeat
  76. the previous process the file pattern will be set not to show the index files
  77. (other html files will appear) or any thumbnails.
  78.  
  79. Advanced : All the parameters are constants defined in the script
  80. itself this means if you want to change things you will need to edit the
  81. script yourself Shreaks of horror!!!. Don't worry its dead easily if
  82. you can type and breath (preferably at the same time). All the values that
  83. you may wish to change are near the top of the script:
  84.  
  85. /* PROGRAM CONSTANTS - change these values to suit */
  86. HTMLFile='Index.html'   /* What to call the html file, Oh Yes */
  87. SquareSize=100               /* Size of square into which to fit pic */
  88. TNFormat='PNG'          /* Thumbnail file format */
  89. TNArgs='INTERLACE=ADAM7'/* Thumbnail file format arguments */
  90. TNExten='png'           /* Thumnail file extension */
  91. TNPrefix='TN'           /* Thumbnail prefix */
  92. TableColumns=5              /* No. of pics per row */
  93. TableRows=10            /* No. of rows in table in each index file */
  94. TableBorder=1           /* Size of table borders, in pixels */
  95. FilePattern='~('HTMLFile'|'TNPrefix'#?)' /* only change if you understand arexx */
  96.  
  97.  
  98. Useful Tips
  99.  
  100.  Minimise the image window before batch processing a lot of images as it will
  101. make the redraw time shorter and decrease the time for the batch process to run
  102.  
  103.  
  104. To do
  105.  
  106. All done! (Hopefully)
  107.  
  108.  
  109. History
  110.  
  111. V1.0 2 Nov 97 by James Perrin
  112. V2.0 19 Nov 97 added ability to update an index if new images have been added to the directory
  113. V2.1 24 May 98 added skipping of files unable to load eg progressive jpegs
  114. V2.1D 25 May 98 added thumbnail dimension gernation, split development into two scripts
  115. V3.0 25 June 98 added max table rows => multiple HTML file generation
  116. V3.1 20 Jan 99 add constant for file args. Second public release
  117.  
  118.  
  119. Who wrote this?
  120.  
  121. James S Perrin j.perrin@mcc.ac.uk
  122. This archive is freely distributable as long as the archive remains
  123. unchanged. Copyright remains with the author. I'd appreciate an email if
  124. anyone likes it.
  125.